Java程序制作Docker Image推荐方案

原文地址

本文源代码是一个spring-boot应用（在 https://github.com/chanjarste... ），不过本例子适用于所有Java应用。

要求

这里先给出一些Docker Image制作的要求，之后我们再看怎么做。

1. 制作过程要融合在项目构建过程中
2. 使用官方Image作为基础Image
3. 设定正确的时区
4. Container内的程序以非root用户启动
5. 指定Web程序的端口
6. 能够传递JVM参数、Java System Properties、程序自定义的参数

下面具体讲一下具体怎么做到以上几点：

制作过程要融合在项目构建过程中

这里推荐使用Spotify的dockerfile-maven-plugin，理由是这个plugin用起来最简单且容易掌握。

该plugin的本质上是你写一个Dockerfile（关于Dockerfile的具体写法请参照官方文档），这个plugin把一些参数传递进去来帮助你构建Docker Image。

因此只要你会写Dockerfile，就会使用这个plugin，它没有加入任何额外的概念。

使用官方Image作为基础Image

Java的基础镜像应该在openjdk repository里寻找，而不是在已经过时的java repository里找。

openjdk repository提供了各种各样的image tags看起来眼花缭乱，但是本质上来说就这么几个：

• openjdk:<version>
• openjdk:<version>-slim
• openjdk:<version>-alpine

关于<version>一般来说指定大版本号就行了，比如你可以在Dockerfile这样写：

FROM openjdk:8-alpine

从尺寸上来讲，alpine最小、slim稍大、默认的最大。所以应该尽可能的使用alpine版本的，如果发现程序的运行环境缺少某些东西，那么尝试用slim版本或者默认版本。就目前的经验来讲：

• 如果需要操作系统字体库，那么就得使用slim版本或者默认版本。需要操作系统字体库的程序例如：图片验证码、PDF导出。
• 如果需要某些Linux标准的动态/静态连接库，那么在alpine版本不行的情况下，尝试slim版本或默认版本。因为alpine版本是一个及其精简的Linux，它删除了很多东西。

设定正确的时区

几乎所有的Docker Image的时区都是UTC，我们需要给我们自己制作的Docker Image设定时区：

ENV TZ=Asia/Shanghai
RUN set -eux; \
    ln -snf /usr/share/zoneinfo/$TZ /etc/localtime; \
    echo $TZ > /etc/timezone

如果是alpine系列的则要安装tzdata：

ENV TZ=Asia/Shanghai
RUN set -eux; \
    apk add --no-cache --update tzdata; \
    ln -snf /usr/share/zoneinfo/$TZ /etc/localtime; \
    echo $TZ > /etc/timezone

关于数据库时区的相关内容可以见：

• 数据库时区那些事儿 - MySQL的时区处理
• 数据库时区那些事儿 - Oracle的时区处理

Container内的程序以非root用户启动

在Docker Image内部，我们应该使用非root用户启动程序，这需要新建用户。

如果你用的是openjdk:<version>-alpine新建用户命令是这样的：

RUN set -eux; \
    addgroup --gid 1000 java-app; \
    adduser -S -u 1000 -g java-app -h /home/java-app/ -s /bin/sh -D java-app;

如果你用的是openjdk:<version>-slim或者openjdk:<version>新建用户命令是这样的：

RUN set -eux; \
    addgroup --gid 1000 java-app; \
    adduser --system --uid 1000 --gid 1000 --home=/home/java-app/ --shell=/bin/sh --disabled-password java-app;

然后使用Dockerfile USER指令

USER java-app

# 后面的指令就都是以java-app用户身份执行了

指定Web程序的接口

对于联网应用而言，必须在Dockerfile中指定暴露的端口，否则该端口无法映射。

EXPOSE 8080

能够传递JVM参数、Java System Properties、程序自定义的参数

我们需要能够在启动Docker Image的时候将一些参数传递进去：

• JVM参数
• Java System Properties
• 程序启动参数

这里就需要参考Dockerfile best practice和Docker ENTRYPOINT了。

样例项目拆解

目录结构

所有与程序相关的东西都存放在/home/java-app/下：

/home/java-app
   ├── docker-entrypoint.sh
   ├── lib
   │   └── java-app.jar
   ├── etc
   ├── logs
   └── tmp

• docker-entrypoint.sh，启动脚本
• lib，存放JAR包
• lib/java-app.jar，程序JAR包
• etc，存放配置文件
• logs，存放日志文件
• tmp，存放临时文件

构建Image的方法

mvn clean package dockerfile:build

运行

普通启动，然后访问http://localhost:8080：

docker run -p 8080:8080 chanjarster/dockerfile-java-examples-1:1.0-SNAPSHOT

设定JVM参数/System Properties，使用JAVA_OPTS环境变量：

docker run -p 8080:8080 -e JAVA_OPTS='-Xmx128M -Xms128M -Dabc=xyz -Ddef=uvw' chanjarster/dockerfile-java-examples-1:1.0-SNAPSHOT

提供程序运行参数，在后面直接添加即可：

docker run -p 8080:8080 chanjarster/dockerfile-java-examples-1:1.0-SNAPSHOT --debug

2018-12-27更新

在docker-entrypoint.sh里启动Java进程时，使用exec /usr/bin/java ...这种形式，保证进程PID=1，这样在进程能够在docker stop时收到SIGTERM。
详见：docker stop

参考文档

• Dockerfile best practice
• Docker ENTRYPOINT
• Postgres Dockerfile & script
• MySQL Dockerfile & script
• Bash set命令教程